AuthService

interface AuthService

A group of shared of methods used by authentication services

Inheritors

Types

Link copied to clipboard
Link copied to clipboard
@Serializable
data class GeneralAuthInfo(val enabled: Boolean, val duration: Int)
Link copied to clipboard
@Serializable
data class OAuth2AuthInfo(val enabled: Boolean, val providers: List<AuthService.OAuth2ProviderInfo>)
Link copied to clipboard
@Serializable
data class OAuth2ProviderInfo(val name: String, val state: String, val codeVerifier: String, val codeChallenge: String, val codeChallengeMethod: String, val authURL: String)
Link copied to clipboard
@Serializable
data class PasswordAuthInfo(val enabled: Boolean, val identityFields: List<String>)

Properties

Link copied to clipboard
abstract val client: PocketbaseClient

Functions

Link copied to clipboard
open suspend fun confirmEmailChange(collection: String, emailChangeToken: String, password: String): Boolean

Confirms email address change.

Link copied to clipboard
open suspend fun confirmPasswordReset(collection: String, passwordResetToken: String, password: String, passwordConfirm: String): Boolean

Confirms a password reset request and sets a new auth record password.

Link copied to clipboard
open suspend fun confirmVerification(collection: String, verificationToken: String): Boolean

Confirms an email address verification request.

Link copied to clipboard
open suspend fun listAuthMethods(collection: String, fields: ShowFields = ShowFields()): AuthService.AuthMethodsList

returns a public list with the allowed collection authentication methods

Link copied to clipboard
open suspend fun requestEmailChange(collection: String, newEmail: String): Boolean

Sends an email change request for an authenticated record.

Link copied to clipboard
open suspend fun requestPasswordReset(collection: String, email: String): Boolean

Sends a password reset email to a specified auth record email.

Link copied to clipboard
open suspend fun requestVerification(collection: String, email: String): Boolean

Sends auth record verification email request.